docs: add scout_last_observed_version to ingestion troubleshooting section#3513
docs: add scout_last_observed_version to ingestion troubleshooting section#3513ericpretzel wants to merge 2 commits into
Conversation
|
🌿 Preview your docs: https://nvidia-preview-pull-request-3513.docs.buildwithfern.com/infra-controller |
Summary by CodeRabbit
WalkthroughThe host ingestion failure playbook adds a “Check the Scout version” step. It documents querying NICo’s ChangesHost ingestion troubleshooting
Estimated code review effort: 1 (Trivial) | ~2 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
🔍 Container Scan SummaryNo Grype artifacts were found to aggregate. |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/playbooks/stuck_objects/host_ingestion_failures.md`:
- Around line 105-109: Update the documentation describing
last_scout_observed_version to state that NICo updates it only when discovery is
reported by Scout with a non-empty discovery_reporter_version; discoveries
without a version leave the previous value unchanged. Clarify that commands
render stored null or missing values as “unknown,” while preserving the existing
explanation that later qualifying Scout discoveries replace the stored value.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Enterprise
Run ID: 09367614-b241-4b28-8ed2-12ad2ded7a19
📒 Files selected for processing (1)
docs/playbooks/stuck_objects/host_ingestion_failures.md
| The `last_scout_observed_version` value is updated whenever Scout registers the | ||
| host during discovery and remains associated with the machine after assignment. | ||
| It identifies the last discovery image, not necessarily a currently running agent. | ||
| The value is `null` for machines that have not completed discovery with a Scout | ||
| version that reports it, and a later Scout discovery replaces the stored value. |
There was a problem hiding this comment.
🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win
Align the update semantics with the producer contract.
The field is updated only when the discovery reporter is Scout and discovery_reporter_version is non-empty (crates/api-core/src/handlers/machine_discovery.rs:433-445). Therefore, “whenever Scout registers” overstates the behavior: a discovery without a version leaves the previous value unchanged. Please state that NICo updates it when it receives a non-empty Scout version, and clarify that the command renders stored null/missing values as unknown.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@docs/playbooks/stuck_objects/host_ingestion_failures.md` around lines 105 -
109, Update the documentation describing last_scout_observed_version to state
that NICo updates it only when discovery is reported by Scout with a non-empty
discovery_reporter_version; discoveries without a version leave the previous
value unchanged. Clarify that commands render stored null or missing values as
“unknown,” while preserving the existing explanation that later qualifying Scout
discoveries replace the stored value.
Source: Path instructions
1 participant
Documenting #2037 - makes site operators aware of the
last_scout_observed_versionvalue exposed in Core and how it can be used to help troubleshoot.Type of Change
Breaking Changes
Testing
Additional Notes